Development guidelines

This page provides detailed development guidelines for contributors and maintainers working on the Bulk Messaging System. It covers code style standards, component architecture, testing strategies, performance optimization, contribution workflow, environment setup, debugging, CI/CD processes, and quality assurance practices. The project combines an Electron desktop application with React for the UI, Python backend services for contact processing, and integrates with external APIs for WhatsApp and email services.

The repository is organized into distinct areas:

• Electron application with React UI and Electron main/preload processes
• Python backend for contact processing and validation
• GitHub Actions workflows for CI/CD
• Local development utilities

graph TB
subgraph "Electron App"
EUI["React UI<br/>App.jsx, main.jsx"]
EC["Components<br/>BulkMailer.jsx, Forms.jsx"]
EM["Electron Main<br/>main.js"]
EP["Preload Bridge<br/>preload.js"]
EB["Builder Config<br/>electron-builder.json"]
end
subgraph "Python Backend"
PBA["Flask API<br/>app.py"]
PBReq["Requirements<br/>requirements.txt"]
end
subgraph "CI/CD"
GH["GitHub Workflows<br/>release.yml"]
end
EUI --> EC
EC --> EM
EM --> EP
EP --> EUI
EM --> PBA
PBA --> PBReq
GH --> EB

• React UI and Application Shell
  • App.jsx renders the main application container and mounts BulkMailer.
  • main.jsx initializes the React root and renders App.
• Electron Main Process
  • main.js sets up the BrowserWindow, configures web preferences, handles IPC channels for Gmail, SMTP, and WhatsApp, and manages lifecycle events.
  • preload.js exposes a secure API surface to the renderer via contextBridge.
• Component Architecture
  • BulkMailer.jsx orchestrates tabs (WhatsApp, Gmail, SMTP), manages state, and coordinates IPC calls.
  • WhatsAppForm.jsx, GmailForm.jsx, and SMTPForm.jsx encapsulate UI and user interactions for each channel.
• Python Backend
  • app.py provides endpoints for contact upload, manual number parsing, and single number validation using Flask and pandas.

The system follows a clear separation of concerns:

• Renderer (React) handles UI and user interactions
• Preload bridges secure IPC calls to the main process
• Main process executes Electron APIs, manages external integrations, and emits status updates
• Python backend provides reusable utilities for contact processing and validation

sequenceDiagram
participant UI as "React UI"
participant Preload as "Preload Bridge"
participant Main as "Electron Main"
participant WA as "WhatsApp Client"
participant Gmail as "Gmail Handler"
participant SMTP as "SMTP Handler"
UI->>Preload : invoke('whatsapp-start-client')
Preload->>Main : ipcRenderer.invoke('whatsapp-start-client')
Main->>WA : initialize client
WA-->>Main : status events (qr, ready, authenticated)
Main-->>Preload : status updates
Preload-->>UI : onWhatsAppStatus/onWhatsAppQR callbacks
UI->>Preload : invoke('send-email', payload)
Preload->>Main : ipcRenderer.invoke('send-email')
Main->>Gmail : handleSendEmail
Gmail-->>Main : progress/results
Main-->>Preload : email-progress events
Preload-->>UI : onProgress listeners

React component architecture guidelines#

• Prefer functional components with hooks for state and effects
• Centralize cross-tab state in BulkMailer.jsx and pass down props to specialized forms
• Use controlled components for inputs and derive derived state (e.g., recipient counts)
• Manage IPC subscriptions in useEffect and return cleanup functions to prevent leaks
• Keep UI components presentation-focused; delegate data fetching and side effects to the main process

classDiagram
class App {
+renders BulkMailer
}
class BulkMailer {
+state : activeTab, emailList, subject, message, delay, smtpConfig, results
+effects : subscribe to WhatsApp status/QR/send-status
+methods : authenticateGmail, importEmailList, sendGmailBulk, sendSMTPBulk
}
class WhatsAppForm {
+props : waContacts, waMessage, waStatus, waQR, waSending, waResults
+actions : startWhatsAppClient, logoutWhatsApp, importWhatsAppContacts, sendWhatsAppBulk
}
class GmailForm {
+props : isGmailAuthenticated, emailList, subject, message, delay, results
+actions : importEmailList, authenticateGmail, sendGmailBulk
}
class SMTPForm {
+props : smtpConfig, emailList, subject, message, delay, results
+actions : importEmailList, sendSMTPBulk
}
App --> BulkMailer
BulkMailer --> WhatsAppForm
BulkMailer --> GmailForm
BulkMailer --> SMTPForm

Electron main process and IPC#

• Security-first configuration: context isolation enabled, nodeIntegration disabled, preload script defines safe APIs
• IPC channels for WhatsApp (client lifecycle, QR, status, send), Gmail (auth, token, send), and SMTP (send)
• Reliable error handling and cleanup on app close/quit
• Status updates propagated via ipcRenderer events to the renderer

flowchart TD
Start(["App Ready"]) --> CreateWindow["Create BrowserWindow<br/>with webPreferences"]
CreateWindow --> DevOrProd{"Development?"}
DevOrProd --> |Yes| LoadDev["Load http://localhost:5173"]
DevOrProd --> |No| LoadDist["Load dist-react/index.html"]
LoadDev --> ListenIPC["Register IPC Handlers"]
LoadDist --> ListenIPC
ListenIPC --> Events["Handle Events:<br/>whatsapp-start-client<br/>whatsapp-send-messages<br/>gmail-auth/gmail-token/send-email<br/>smtp-send"]
Events --> Cleanup["Cleanup on window-all-closed<br/>and before-quit"]
Cleanup --> End(["Exit"])

Python backend services#

• Flask app with CORS enabled
• Endpoints for health checks, file uploads, manual number parsing, and single number validation
• Uses pandas for reliable CSV/Excel parsing and regex-based phone number cleaning
• Secure file handling with allowed extensions and upload directory management

flowchart TD
Health["GET /health"] --> Healthy["Return healthy status"]
Upload["POST /upload<br/>multipart/form-data"] --> CheckExt{"Allowed extension?"}
CheckExt --> |No| Err400["Return 400 Invalid file type"]
CheckExt --> |Yes| Save["Save file to uploads/<filename>"]
Save --> Parse["Detect type and parse:<br/>CSV -> extract_contacts_from_csv<br/>TXT -> extract_contacts_from_txt<br/>XLS/XLSX -> extract_contacts_from_excel"]
Parse --> Clean["Clean and validate phone numbers"]
Clean --> Respond["Return contacts + count"]
Manual["POST /parse-manual-numbers"] --> Split["Split by newline/separator"]
Split --> Extract["Extract name/number pairs or standalone numbers"]
Extract --> Clean2["Clean and validate"]
Clean2 --> Resp2["Return contacts + count"]
Validate["POST /validate-number"] --> Clean3["Clean number"]
Clean3 --> Resp3["Return validity + cleaned number"]

• Electron dependencies include React, TailwindCSS, whatsapp-web.js, nodemailer, googleapis, and qrcode libraries
• Vite is configured with React and Tailwind plugins, serving the React app locally and building to dist-react
• electron-builder bundles the React and Electron resources into platform-specific distributables

graph LR
Vite["Vite Config<br/>vite.config.js"] --> ReactPlugin["@vitejs/plugin-react"]
Vite --> Tailwind["@tailwindcss/vite"]
Vite --> OutDir["outDir: dist-react"]
ElectronPkg["Electron Package<br/>package.json"] --> ReactDeps["react, react-dom"]
ElectronPkg --> UIUtils["qrcode, qrcode-terminal, electron-store"]
ElectronPkg --> Integrations["whatsapp-web.js, nodemailer, googleapis"]
ElectronPkg --> Tooling["@vitejs/plugin-react, tailwindcss, vite, eslint, electron-builder"]
Builder["electron-builder.json"] --> Files["files: dist-electron, dist-react"]
Builder --> Targets["mac dmg, linux AppImage, win portable/msi"]

• Electron
  • Headless browser mode for WhatsApp client reduces overhead; ensure sandbox and GPU flags are configured appropriately
  • Minimize heavy DOM rendering; use virtualized lists for large contact/email previews
  • Debounce user input for large text areas to reduce re-renders
• React
  • Use React.memo for components that render large lists (e.g., contact previews)
  • Split heavy computations into Web Workers or preload-bound tasks
  • Avoid unnecessary re-renders by memoizing derived values and callbacks
• Python Backend
  • Use pandas vectorized operations for CSV/Excel parsing
  • Stream file reads/writes to avoid loading entire files into memory
  • Cache validated numbers where appropriate to reduce repeated validations
• IPC
  • Batch status updates to reduce IPC overhead
  • Use throttled progress events for long-running operations

[No sources needed since this section provides general guidance]

• Unit Testing
  • React: Use a testing library to test pure functions and component logic (e.g., form validation, state transitions)
  • Python: Write pytest tests for app.py endpoints, ensuring coverage of parsing, validation, and error paths
• Integration Testing
  • Electron: Mock IPC handlers to simulate WhatsApp/Gmail/SMTP flows without external dependencies
  • End-to-end: Use a testing framework to automate UI interactions and verify IPC events
• End-to-End Testing
  • Electron: Automate user flows (connect to WhatsApp, import contacts, send messages) and assert status updates
  • Python: Validate backend endpoints with realistic payloads and edge cases

[No sources needed since this section provides general guidance]

• Fork the repository and create feature branches with descriptive names
• Follow code style standards enforced by ESLint
• Add tests for new features and update documentation
• Ensure cross-platform compatibility and thorough testing before opening a pull request

• Prerequisites
  • Node.js 16+ and npm for the Electron app
  • Python 3.8+ for backend utilities
  • Google Cloud Console credentials for Gmail API
  • WhatsApp account and SMTP server credentials
• Installation
  • Install Electron dependencies in the electron directory
  • Install Python backend dependencies in python-backend
  • Start the development server from the electron directory
• Configuration
  • Create a.env file in the electron directory with GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET
  • Configure SMTP settings for email sending

• Electron
  • Use DevTools in development mode; main process logs are visible in terminal
  • Inspect network requests and IPC traffic in DevTools
  • Validate preload exposure and IPC handler registration
• React
  • Use React DevTools to inspect component props/state
  • Add console logs for IPC callbacks and status updates
• Python Backend
  • Enable Flask debug mode for development
  • Validate file uploads and endpoint responses with curl or Postman

• GitHub Actions workflows
  • Release workflow builds Electron apps for macOS, Linux, and Windows
  • Distributables include platform-specific packages (DMG, AppImage, EXE, MSI, ZIP, TAR.GZ)
  • Release notes are generated automatically
• Release Process
  • Update version in electron/package.json
  • Push git tags to trigger the workflow
  • Review artifacts and finalize releases

sequenceDiagram
participant Dev as "Developer"
participant Git as "Git Tags"
participant GH as "GitHub Actions"
participant Dist as "Artifacts"
Dev->>Git : git push origin main --tags
Git->>GH : Trigger release.yml on tag v*
GH->>GH : Setup Node.js, install deps, build Electron
GH->>GH : Build platform-specific distributables
GH->>Dist : Upload artifacts
GH->>GH : Create GitHub release with release notes

• Code Style
  • Adhere to ESLint configuration for JavaScript/React
  • Use functional components with hooks and avoid class components
• Security
  • Never expose sensitive data in the renderer process
  • Validate and sanitize all user inputs
• Reliability
  • Implement proper error boundaries and graceful degradation
  • Ensure cleanup of external resources (WhatsApp sessions, file handles)
• Documentation
  • Update README for new features and configuration changes
  • Comment complex logic and trade-offs

• Keep README updated with installation, configuration, and usage instructions
• Document new endpoints, configuration options, and breaking changes
• Provide troubleshooting sections for common issues

• Automated Checks
  • Linting with ESLint
  • Building and packaging verification
• Manual QA
  • Cross-platform testing (Windows, macOS, Linux)
  • End-to-end user flows for WhatsApp, Gmail, and SMTP
• Security Review
  • Audit context isolation and IPC exposure
  • Validate OAuth2 and SMTP credential handling

• Common Issues
  • WhatsApp QR code not loading: check internet connection and restart the app
  • Gmail authentication failure: verify OAuth2 credentials and API enablement
  • SMTP connection issues: confirm server settings, firewall, and port/security
  • Contact import errors: verify file format, encoding, and column headers
• Support
  • Check README troubleshooting section
  • Review existing issues and create new ones with system information and error logs

This page consolidates development practices for the Bulk Messaging System. By following the outlined guidelines, code style, component architecture, testing, performance, contribution workflow, environment setup, debugging, CI/CD, code review, documentation, and QA, you can contribute effectively and maintain a high-quality, secure, and reliable application across Electron, React, and Python backend components.